package one.microstream.persistence.types;

/*-
 * #%L
 * microstream-persistence
 * %%
 * Copyright (C) 2019 - 2022 MicroStream Software
 * %%
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 * 
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License, v. 2.0 are satisfied: GNU General Public License, version 2
 * with the GNU Classpath Exception which is
 * available at https://www.gnu.org/software/classpath/license.html.
 * 
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 * #L%
 */

public interface PersistenceLegacyTypeHandlingListener<D>
{
	public <T> void registerLegacyTypeHandlingCreation(
		long                         objectId             ,
		T                            instance             ,
		PersistenceTypeDefinition    legacyTypeDescription,
		PersistenceTypeHandler<D, T> currentTypeHandler
	);
	
	/* note:
	 * further listening wishes (before creation, before/after update or completion, or whatever)
	 * can be implemented by using a LegacyTypeHandler wrapper implementing inserted by a
	 * wrapping LegacyTypeHandlerCreator. That approach makes this explicit listener almost redundant,
	 * but it is a little easier and nicer to have the basic creation listening in this concrete way.
	 * All beyond-basic needs are better implemented with the wrapping approach.
	 */
}
